Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Prepare for 2.0.0 release. #437

Merged
merged 2 commits into from
Aug 12, 2024
Merged

Conversation

jholdstock
Copy link
Member

No description provided.

README.md Outdated
@@ -65,7 +65,7 @@ mining, a certificate from an authority (`CA`) like
command without cloning this repository:

```sh
$ go install github.com/decred/dcrpool@v1.3.0
$ go install github.com/decred/dcrpool@v2.0.0
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This won't work. The reason we use release-v2.0.0 is because if you use v2.0.0 you will have to bump the major module version to include /v2 in the go.mod, meaning this would have to be go install github.com/decred/dcrpool/v2@v2.0.0.

Copy link
Member

@davecgh davecgh Aug 5, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unfortunately, I see that the pool package is not internal and thus if its API changes in a breaking way, the main dcrpool module needs to have its major bumped.

I compared against v.1.2.0 via git diff v1.2.0..HEAD pool and I see that at the very least pool.ChainStateConfig, pool.ClientConfig, and pool.EndpointConfig were changed in a breaking way, so that technically forces the main dcrpool module to become /v2.

We can probably get away with not bumping it though because there are no external importers of the module.

For what it's worth, this is why there should not be any code exported from the main module at all when the main module is the application itself. It's a mistake that dcrwallet makes too. It constantly forces major module version bumps which is super annoying for consumers and constantly break install scripts, version linker flags (because they have to become .../v2.Release) , etc.

The pool package should probably be moved to internal to avoid this issue in the future.

The earlier commit to change the version to 1.3.0 was a mistake. The
major version needs to be bumped due to changes to the database code
which are not backwards compatible.
@davecgh
Copy link
Member

davecgh commented Aug 7, 2024

Are you planning on creating the release-v2.0 branch and commit that remove the -pre after this?

@jholdstock
Copy link
Member Author

Exactly. Following this PR:

  • Create a release-v2.0 branch with -pre removed from version
  • Tag release-v2.0.0 from that branch
  • Create a PR on master to bump version to 2.1.0-pre

@jholdstock jholdstock merged commit de626cd into decred:master Aug 12, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants